Skip to content

feat: add kube_deployment_owner metric #2782

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Oct 10, 2025
Merged

feat: add kube_deployment_owner metric #2782

merged 1 commit into from
Oct 10, 2025
+96 −0

Conversation

nmn3m
Copy link
Member

@nmn3m nmn3m commented Sep 21, 2025

What this PR does / why we need it:
This PR adds a new metric kube_deployment_owner to track ownership information for Deployments. This is particularly useful for identifying Deployments managed by Operators or other controllers in the Kubernetes ecosystem. The metric includes information about the owner's kind, name, and whether it's a controller, making it easier to understand the ownership hierarchy in clusters.

How does this change affect the cardinality of KSM: increases cardinality
This change adds one new metric with additional labels (owner_kind, owner_name, owner_is_controller) for each Deployment in the cluster.

Which issue(s) this PR fixes:
Fixes #2674

The new metric provides the following information:

  • Owner kind (e.g., Application, CustomResource)
  • Owner name

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Sep 21, 2025
@k8s-ci-robot k8s-ci-robot added the needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. label Sep 21, 2025
@k8s-ci-robot
Copy link
Contributor

This issue is currently awaiting triage.

If kube-state-metrics contributors determine this is a relevant issue, they will accept it by applying the triage/accepted label and provide further guidance.

The triage/accepted label can be added by org members by writing /triage accepted in a comment.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@github-project-automation github-project-automation bot moved this to Needs Triage in SIG Instrumentation Sep 21, 2025
@k8s-ci-robot k8s-ci-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Sep 21, 2025
@CatherineF-dev
Copy link
Contributor

Could you provide some use cases for this metric?

@nmn3m
Copy link
Member Author

nmn3m commented Sep 23, 2025

@CatherineF-dev

  • Tracking Ownership & Orphaned Deployments: Identifies which Deployments are owned by controllers, and helps quickly find orphaned resources.

  • Debugging, Monitoring & Auditing: Aids in troubleshooting by linking issues to the controller, provides visibility for monitoring, and supports auditing/compliance.

CatherineF-dev
CatherineF-dev reviewed Sep 23, 2025
View reviewed changes
@nmn3m nmn3m force-pushed the deployment-owner-metric branch from cd49f71 to 3cf5221 Compare October 9, 2025 16:28
@k8s-ci-robot k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Oct 9, 2025
@nmn3m nmn3m mentioned this pull request Oct 9, 2025
Open
@CatherineF-dev
Copy link
Contributor

/lgtm

@k8s-ci-robot k8s-ci-robot added lgtm "Looks good to me", indicates that a PR is ready to be merged. approved Indicates a PR has been approved by an approver from all required OWNERS files. labels Oct 10, 2025
@CatherineF-dev
Copy link
Contributor

/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: CatherineF-dev, nmn3m

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot merged commit 3214ab1 into kubernetes:main Oct 10, 2025
13 checks passed
@github-project-automation github-project-automation bot moved this from Needs Triage to Done in SIG Instrumentation Oct 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@logicalhan logicalhan Awaiting requested review from logicalhan

@CatherineF-dev CatherineF-dev Awaiting requested review from CatherineF-dev

Assignees

@CatherineF-dev CatherineF-dev

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.

Projects

SIG Instrumentation
Status: Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Add kube_deployment_owner

3 participants

@nmn3m @k8s-ci-robot @CatherineF-dev